﻿// Artificial Intelligence for Humans
// Volume 3: Deep Learning and Neural Networks
// C# Version
// http://www.aifh.org
// http://www.jeffheaton.com
//
// Code repository:
// https://github.com/jeffheaton/aifh
//
// Copyright 2015 by Jeff Heaton
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// For more information on Heaton Research copyrights, licenses
// and trademarks visit:
// http://www.heatonresearch.com/copyright
//

using System.Collections.Generic;

namespace AIFH_Vol3_Core.Core.Selection
{
    /// <summary>
    ///     Base class for model selection searches.
    /// </summary>
    public abstract class ModelSelection
    {
        /// <summary>
        ///     The axes.
        /// </summary>
        private readonly IList<ISearchAxis> searchAxises = new List<ISearchAxis>();

        /// <summary>
        ///     The search axes.
        /// </summary>
        public IList<ISearchAxis> SearchAxises
        {
            get { return searchAxises; }
        }

        /// <summary>
        ///     Add a numeric axis.
        /// </summary>
        /// <param name="start">The start of the axis.</param>
        /// <param name="stop">The end of the axis.</param>
        /// <param name="step">The step.</param>
        public void AddNumericAxis(double start, double stop, double step)
        {
            searchAxises.Add(new NumericSearchAxis(start, stop, step));
        }

        /// <summary>
        ///     Add a category axis.
        /// </summary>
        /// <param name="list">The list of categories.</param>
        public void AddCategoryAxis(string[] list)
        {
            searchAxises.Add(new CategorySearchAxis(list));
        }

        /// <summary>
        ///     Get the next element to search.
        /// </summary>
        /// <returns>The next element to search.</returns>
        public abstract object[] Next();
    }
}